🚀 VaultsPay API v1 is live. See what's new →
Direct TransfersCreate Payment Contact

Create Payment Contact

After validating the IBAN, the SaaS app must create a payment contact using the validated IBAN. To perform this operation, the SaaS app should call the API below with the specified attributes.

POST{baseUrl}/be/api/v1/direct-payment-contact

Payload

AttributeDescription
titleRequired. Give a title to your payment contact.
ibanRequired. Validated IBAN.
accountTitleOptional. If the third party does not return the account title, the user must provide the title as input.
Request Example
{
  "title": "John Salary Account",
  "iban": "AE000000000000000000000",
  "accountTitle": null
}

Response

AttributeDescription
dataContains the Payment Contact details.
data.idUnique key of the Payment Contact.
200 — SUCCESS
{
  "data": {
    "id": 1995,
    "title": "Direct payment",
    "userId": 5,
    "details": {
      "bankCode": "096",
      "accountTitle": "Adamz Ahme*",
      "iban": "AE680961000648060000040",
      "swiftCode": "ZANDAEAAXXX",
      "bankName": "Zand Bank PJSC"
    },
    "status": true,
    "thirdPartyConfigId": 14
  }
}
422 — Account Title Missing
{
  "code": 1000,
  "message": "Invalid payload. Please check your request.",
  "type": "INVALID_PAYLOAD",
  "errors": [
    {
      "key": "accountTitle",
      "reason": "Account title is missing"
    }
  ]
}
422 — Title Missing
{
  "code": 1000,
  "message": "Invalid payload. Please check your request.",
  "type": "INVALID_PAYLOAD",
  "errors": [
    {
      "key": "title",
      "reason": "Payment Contact Title is required"
    }
  ]
}
500 — Payment Contact Already Exists
{
  "code": 1010,
  "message": "Payment Contact already exists",
  "type": "BAD_REQUEST"
}
500 — Invalid IBAN
{
  "code": 1010,
  "message": "Invalid IBAN",
  "type": "BAD_REQUEST"
}