Create a payment provider

post/payment-providers
SecuritybearerAuth
Request
Request Body schema: application/json

New payment provider

type
required
string (PaymentMethod)

Payment method

Enum: "CHEQUE" "DIRECT_DEBIT" "CANCELLED_DD" "CREDIT_CARD" "PAYPAL" "BACS" "POST_OFFICE_PAYMENT_CARD" "EZYPAY" "GO_CARDLESS" "GC_INSTANT_BANK_PAYMENTS" "STRIPE" "FINASTRA" "FAST_PAY" "OTHER"
name
required
string [ 0 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Payment provider name

directDebitWithName
string [ 0 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Payment provider direct debit name

status
required
string (PaymentProviderStatus)

Payment provider status

Enum: "ACTIVE" "INACTIVE"
creditorIdentifier
string [ 0 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Payment provider creditor identifier

instantBankPayments
boolean
Default: false

Does this payment provider support instant bank payments

retryIfPossible
boolean
Default: false

Payment provider will retry the payment if possible

contractOwnerIds
Array of integers <int32>

Contract owner identifiers

Responses
200

Payment provider created

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples
application/json
{
  • "type": "CHEQUE",
  • "name": "string",
  • "directDebitWithName": "string",
  • "status": "ACTIVE",
  • "creditorIdentifier": "string",
  • "instantBankPayments": false,
  • "retryIfPossible": false,
  • "contractOwnerIds": [
    • 1
    ]
}
Response samples
application/json
{
  • "id": 1,
  • "type": "CHEQUE",
  • "name": "string",
  • "directDebitWithName": "string",
  • "status": "ACTIVE",
  • "creditorIdentifier": "string",
  • "instantBankPayments": false,
  • "retryIfPossible": false,
  • "contractOwnerIds": [
    • 1
    ]
}