Create a custom payment redirect address

post https://api.sandbox.crezco.com/v1/users/{userId}/pay-demands/{payDemandId}/payment

Custom redirect URLs allow specification of both the initial and final screen of the payment user's journey:

InitialScreen

DetailsCheck: The standard payment confirmation screen, showing all details of the PayDemand
BankSelection: The bank selection screen
ContinueToBank: A screen redirecting the the specified bank

NOTE: Using ContinueToBank also requires bankId and countryIso2Code. Bank details are available using
the v1/banks/ endpoint

FinalScreen

PaymentStatus: Payment status, shown until payment reaches a finalised state
PaymentConfirmation: Payment confirmation, allows user to enter email for a receipt
PaymentFeedback: Payment feedback, allows user to rate the payment experience

Successful payments will be directed to successCallbackUri after the FinalScreen.
Cancelled or failed payments will be directed to failureCallbackUri.

Path Params

userId

uuid

required

Unique identifier (UUID) of the user who owns pay demand

payDemandId

uuid

required

Unique identifier (UUID) of the pay demand

Query Params

initialScreen

string

Initial (Crezco) screen presented to the user

finalScreen

string

Final (Crezco) screen presented to the user

bankId

string

Unique identifier for the payer's bank

countryIso2Code

string

Defaults to GB

Country code (2 characters - ISO 3166-1) corresponding to the payer's bank

successCallbackUri

uri

URI that should be used to redirect to after payment is completed

failureCallbackUri

uri

URI that should be used to redirect to after payment has failed or been cancelled

amount

double

Optional payment amount overriding the one specified in the pay demand

reference

string

Optional payment reference overriding the one specified in the pay demand

payerEmail

string

Optional payer's e-mail address if available, to be used for notifications about payment status changes

Responses

200OK

400Bad Request

401Unauthorized

404Not Found

defaultError