Add payment method.

post https://virtserver.swaggerhub.com/singuladecisions/payment-method_service/1.0.16/customer/{customerId}/paymentmethod

Set up customer payment method.
Response Code | Fault Code | Fault | Suggested User Message
------------- | ---------- | ----- | ----------------------
400 | 90000 | InsufficientDataFault | Additional data required
400 | 90054 | ProviderProcessingFault | Payment Provider cannot complete transaction
404 | 90071 | UnknownProviderFault | Requested provider Is unknown
400 | 90047 | PaymentMethodCreationFailedFault | Payment Method creation failure
400 | 90021 | InvalidDigestFault | Provided Digest is incorrect
422 | 90065 | UnavailableProviderFault | Requested Provider is unavailable and cannot complete transaction
400 | 90019 | InvalidCurrencyCodeFault | Currency code provided is incorrect
500 | 90061 | SystemFailureFault | System Failure, please try again later
404 | 90039 | NoAccountFoundFault | Account does not exist
404 | 90070 | UnknownMerchantFault | Merchant does not exist

Path Params

customerId

uuid

required

The ID of the customer the payment method is to be created for

Body Params

The payment method information to store.

provider

string

required

length ≤ 30

The payment provider.
For card methods, the name of the PSP via which the card is processed (e.g. REALEX, DIAGNAL).
For UK Direct Debits, use DIRECT_DEBIT.
For SEPA Direct Debits, use SEPA.

merchantCode

string

length ≤ 100

Merchant code. Required for some providers.

uuid

string

length ≤ 50

Uuid used to calculate digest. Required for some providers.

digest

string

Hashed request details. Required for some providers.

data

array of objects

required

Additional payment method details.
For PSP providers, these will be obtained from the PSP.
For DIRECT_DEBIT provider, the key names and definitions are as follows:

sortCode: The sort code. Either 6 digits (123456) or 3 groups of 2 dash-separated digits (12-34-56)
accountNumber: The account number. 8 digits.
accountName: The account name. Between 3 and 50 characters.
guaranteeAcknowledged: Indicates the customer has read and acknowledged the Direct Debit guarantee. Must be present and set to true

For example:
"data": [
{"key": "sortCode", "value": "83-06-08"},
{"key": "accountNumber", "value": "10498522"},
{"key": "accountName", "value": "Test Accountholder"},
{"key": "guaranteeAcknowledged", "value": true}
]

For SEPA provider, the key names and definitions are as follows:

bic: The BIC. 8 or 11 characters.
iban: The IBAN. Between 15 and 34 characters.
accountName: The account name. Between 3 and 50 characters.
guaranteeAcknowledged: Indicates the customer has read and acknowledged the SEPA Direct Debit guarantee. Must be present and set to true

For example:
"data": [
{"key": "bic", "value": "ULSBIE2D"},
{"key": "iban", "value": "IE88ULSB98555410031435"},
{"key": "accountName", "value": "Test Accountholder"},
{"key": "guaranteeAcknowledged", "value": true}
]

data*

currencyCode

string

required

length ≤ 3

3 character currency code

Headers

tenantId

string

The tenant ID for which the operation is being carried out. This will be automatically generated during the authentication process.

userId

string

The ID of a user who is performing the operation. This will be automatically generated during the authentication process.

source

string

The source of whether records are updated by HMAC or a USER. This will be automatically generated during the authentication process. For customers accessing the service the source will be set to CUSTOMER.

Responses

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://virtserver.swaggerhub.com/singuladecisions/payment-method_service/1.0.16/customer/customerId/paymentmethod \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

201Payment method added successfully.

400Bad request

422Unable to create payment method.