Get Withdrawal Options

GET 
/v2/customers/:customerId/withdrawals/options

Returns list of available withdrawal options.

Add type query parameter to find available THIRDT_PARTY withdrawal options.

Request

Path Parameters

customerId stringrequired

Customer Id.

Query Parameters

type ParticipantType

Possible values: [THIRD_PARTY, FIRST_PARTY]

Default value: FIRST_PARTY

Withdrawal type.

Responses

200

OK

application/json

Schema

Schema

• Array [

paymentOption PaymentOptionType (string)

Possible values: [RAPID_TRANSFER, BANK_TRANSFER, OFFLINE_BANK_TRANSFER, CARD, PAYSAFECASH, PAGO_EFECTIVO]

Enumeration of supported Payment Option Types

type ParticipantType (string)

Possible values: [THIRD_PARTY, FIRST_PARTY]

Default value: FIRST_PARTY

Participant in the payment.

instrumentTypes InstrumentType (string)[]

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, CARD]

Supported instrument types.

paymentOptionSettings

object

deprecated

Provides settings for a specific payment option. Valid payment options are:

• CARD - Represents CardPaymentOptionSettings

paymentOption

string

required

Possible values: [CARD]

Enumeration of supported Payment Option Types

CARD

any

• ]

Example (from schema)

[
  {
    "paymentOption": "CARD",
    "type": "FIRST_PARTY",
    "instrumentTypes": [
      "CARD"
    ]
  }
]

GET_WITHDRAWAL_OPTIONS

[
  {
    "instrumentTypes": [
      "US_BANK_ACCOUNT"
    ],
    "paymentOption": "BANK_TRANSFER"
  },
  {
    "instrumentTypes": [
      "CARD"
    ],
    "paymentOption": "CARD",
    "cardSchemes": [
      "VISA",
      "MC"
    ]
  }
]

405

Method Not Allowed

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

DW-OPERATION-NOT-ALLOWED

{
  "error": {
    "code": "DW-OPERATION-NOT-ALLOWED",
    "message": "Operation is not allowed in your account. Contact Paysafe for further details.",
    "details": [
      "Operation is not allowed in your account. Contact Paysafe for further details."
    ]
  }
}

Loading...