Skip to main content

Deactivate Withdrawal Recipient

DELETE 

/v2/customers/:customerId/recipients/:recipientId

Deactivates recipient for future withdrawals.

Request

Path Parameters

    customerId stringrequired

    Customer Id.

    recipientId stringrequired

    Recipient Id.

Responses

OK

Schema

    id stringrequired

    Withdrawal recipient id.

    status WithdrawalRecipientStatus (string)required

    Possible values: [ACTIVE, INACTIVE]

    Recipient status. Recipients are not deleted but kept for reference. Only ACTIVE recipients can be used for withdrawals.

    creationTime date-timerequired

    Represents RFC 3339, section 5.6 date-time.

    label string

    Possible values: non-empty and <= 100 characters

    Label for the recipient. Use this field to label the recipient, if you want to make additional payments to the same party. If not specified the label is generated by combining the title, first name, and last name. If ACTIVE recipient with the same label already exists a number suffix is added.

    title string

    Possible values: <= 15 characters

    Personal title, Mr., Dr., etc.

    firstName stringrequired

    Possible values: non-empty and <= 50 characters

    First name. Only latin characters, spaces, single quotes, and hyphens are allowed.

    lastName stringrequired

    Possible values: non-empty and <= 50 characters

    Last name. Only latin characters, spaces, single quotes, and hyphens are allowed.

    address

    object

    required

    Address of the customer.

    countryCode CountryCode (string)required

    Possible values: >= 2 characters and <= 2 characters

    ISO-3166 Alpha 2

    stateProvince string

    Possible values: <= 2 characters

    US state postal abbreviation. Not used for non-US territories.

    city stringrequired

    Possible values: <= 50 characters

    City.

    postalCode stringrequired

    Possible values: non-empty and <= 50 characters

    Postal code.

    address1 stringrequired

    Possible values: <= 200 characters

    The first line of the address.

    address2 string

    Possible values: <= 200 characters

    The second line of the address.

    contactInfo

    object

    Represents contact information.

    mobile string

    Possible values: <= 50 characters

    Mobile number.

    email email

    Possible values: >= 6 characters and <= 100 characters

    Email.

    paymentInstrument

    object

    required

    Represents a payment instrument, used for third-party payments. Here are the valid instrumentType values:

    • SEPA_BANK_ACCOUNT - IBAN Bank Account for EEA international transfers

    • UK_BANK_ACCOUNT - UK Bank Account for somestic UK transfers

    • US_BANK_ACCOUNT - US Bank Account for domestic USA transfers

    id uuid

    The instrument id

    instrumentType

    string

    required

    Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT]

    Represents the type of the recipient instrument.

    ValueDescription
    SEPA_BANK_ACCOUNTSEPA Bank account
    UK_BANK_ACCOUNTUK Bank account
    US_BANK_ACCOUNTUS Bank account
    accountHolderName string

    Possible values: <= 100 characters

    This is the name of the customer or company that owns the bank account.

    iban stringrequired

    The International Bank Account Number (IBAN) of the account.

    bic stringrequired

    The Bank Account Bank Identifier Code (BIC) code. Also known as SWIFT code.

    bankName string

    The bank name.

    type stringrequired

    Possible values: [BUSINESS, INDIVIDUAL]

    Recipient type.

Loading...