Update Payee With Beneficiary (Corpay)

This endpoint updates a payee and their beneficiary in a single request for international ACH (iACH) or wire payments through Corpay.

post/apis/updatePayeeWithBeneficiary

Request

  • Base URL: https://sandboxapi.kyckglobal.com
  • URL: https://sandboxapi.kyckglobal.com/apis/updatePayeeWithBeneficiary
  • Auth: none declared

Request body

payerIdstring required

Payer Organization ID.

emailstring email required

Payee email address.

firstNamestring

Payee first name.

lastNamestring

Payee last name.

classificationstring

Payee classification, e.g., Individual or Business.

purposeOfPaymentstring required

Mandatory for iACH/Wire payments. Refer to the PurposeOfPayment API Endpoint.

paymentMethod'E' | 'W'

'E' for iACH, 'W' for wire transfer.

phonestring

Payee phone number.

addressstring

Payee street address.

regionstring

State or region.

citystring

City of the payee.

postalCodestring

Postal or ZIP code.

payeeDBANamestring

Doing Business As name for business payees.

isDBAasReceiverEnabledboolean

Indicates if DBA name should be used as receiver name.

payeeReferenceIdstring

Optional reference ID for the payee.

Example request

{
  "payerId": "K012421P",
  "email": "johndoe@gmail.com",
  "firstName": "John",
  "lastName": "Doe",
  "classification": "Individual",
  "purposeOfPayment": "PROFESSIONAL FEES PAYMENT",
  "phone": "5414232442",
  "address": "Cebesoy Street",
  "region": "Antalya",
  "city": "Antalya",
  "postalCode": "07100",
  "payeeDBAName": "John's Consulting",
  "isDBAasReceiverEnabled": true,
  "payeeReferenceId": "REF123456",
  "account": {
    "iban": "IT60X0542811101000000123456",
    "routingCode": "123456789",
    "accountNumber": "987654321",
    "destinationCountry": "ITA"
  },
  "regulatory": [
    {
      "key": "BeneficiaryAccountType",
      "value": "SVGS"
    }
  ]
}

Response

Update Payee With Beneficiary

successboolean

Indicates if the update was successful.

messagestring

Response message confirming the update.

Example response

{
  "success": true,
  "message": "payee and beneficiary updated successfully"
}

Changes

No recorded changes to this operation across all 1 revision of this API.