No results

GET/contracts/customers/{customerId}

PROD
https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/contracts/customers/{customerId}
TEST
https://xpaysandbox.nexigroup.com/api/phoenix-0.0/psp/api/v1/contracts/customers/{customerId}

Search for contracts using the customer's identification. For more information on contracts, refer to the dedicated Contracts page.

PARAM HEADER
NAME DESCRIPTION FORMAT
X-Api-Key Authentication API Key. String
Format: uuid
Example: 625b4884-38f8-11ed-a261-0242ac120002
Correlation-Id Unique identifier of the request. String
Format: uuid
Example: 4935e818-38e0-11ed-a261-0242ac120002
PARAM PATH
NAME DESCRIPTION FORMAT
customerId Customer identification code. String
Example: 36451278
PARAM QUERY
NAME DESCRIPTION FORMAT
No param query
PARAM BODY

NAME DESCRIPTION FORMAT
No param body
Arrow RESPONSE 200
Request successfully processed - No Header for this response
BODY
NAME DESCRIPTION FORMAT
customerId Customer ID. String
Example: 36451278
contracts Array containing the contracts list. Array
contractId Contract ID. String
Min. length: 1
Max. length: 18
Example: C2834987
contractType * MIT_UNSCHEDULED - once the card has been tokenized, the merchant will carry out subsequent charges with an undefined frequency
* MIT_SCHEDULED - once the card has been tokenized, the merchant will carry out subsequent debits with a defined frequency (eg first of each month)
* CIT - the card is tokenized to allow the cardholder to make subsequent payments faster. Unlike MIT transactions, the merchant will not have the ability to make direct debits on these tokenized cards, as the subsequent CIT payment is subject to authentication (SCA) by the cardholder
String
Example: MIT_UNSCHEDULED
contractExpiryDate Used with contractType MIT_SCHEDULED. String
Example: 2023-03-16
contractFrequency Used with contractType MIT_SCHEDULED. Number of days. String
Max. length: 4
Example: 120
paymentMethod * CARD - Any card circuit
* APM - Alternative payment method
 String
Example: CARD
paymentCircuit one of the payment circuit values returned by the GET payment_methods web service VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY etc. String
Example: VISA
paymentInstrumentInfo Payment instrument information. String
Example: ***6152
Arrow RESPONSE 404
Customer not found - No Header and Body for this response
Arrow RESPONSE 401
Unauthorized - No Header and Body for this response
Arrow RESPONSE 500
Internal Server Error - No Header for this response
BODY
NAME DESCRIPTION FORMAT
errors Array containing the errors list. The possible values are shown in the table Error codes. Array
code Error code. String
Example: GW0001
description Error description. String
Example: Invalid merchant URL