Creating a payment link

URL	https://checkout.pagasul.com/pay
HTTP request method	GET

Request headers

Header	Value	Description
Signature	calculated	For the information on how to generate the signature, see Signature.

Parameters to be sent:

In PagaSul, there are the following types of parameters depending on whether they are required in the request:

Strictly required — the parameter is always required in the request Optional — the parameter is optional Required conditionally — the parameter may be sometimes required depending on the payment method you initiate the payment with. See the Payment methods section to check whether it is required in the request.

Query parameters:

Parameter	Type	Required	Description
client_id	integer	Yes	Your account identifier, provided upon integration
client_payment_id	string	Yes	Your payment ID, must be unique to the client_id used
payment_method	string	Optional	Preselected payment method code (see Supported payment methods section). If not passed, the customer will be presented with a form to select a method from those connected on your client_id
currency	string	Yes	Payment currency (see Supported payment methods section)
amount	decimal	Yes	Requested payment amount (for example: pass 12.34 for 12 dollars 34 cents amount)
payer.id	string	Yes	A unique identifier for a customer or customer account on your side. It is used to accumulate customer data and for anti-fraud protection
payer.is_trusted	boolean	Optional	If passed and "true" customer marked as trusted (for use please consult Pagasul representative)
payer.name	string	Optional	Customer name
payer.email	string	Optional	Customer email
payer.country	string	Optional	Customer country (alpha-2 code)
payer.state	string	Optional	Customer state
payer.city	string	Optional	Customer city
payer.address	string	Optional	Customer address
payer.phone	string	Optional	Customer phone
payer.language	string	Optional	Preferred language for customer
payer.cpf	string	Optional	Customer CPF (Cadastro de Pessoas Físicas) for Brazil payment methods. Can be passed in following formats: "231.002.999-00" or "23100299900"
payer.cuit	string	Optional	Customer CUIT (Unique Tax Identification Code) for Argentina payment methods. Can be passed in following formats: "30-69330706-2" or "30693307062"
payer.citizenship_card	string	Optional	Number of the Citizenship Card (Cédula de Ciudadanía) for Colombian/Ecuadorian payment methods
payer.nit	string	Optional	Unique Taxpayer Number (Número de Identificación Tributaria) for Colombian/Bolivian payment methods
payer.pas	string	Optional	Passport needed for Bolivian/Ecuadorian payment methods
payer.ce	string	Optional	Customer Identity card of Foreigners (Cédula de Extranjería) for Colombian payment methods
payer.ti	string	Optional	Customer identity document (Tarjeta de Identidad) for Colombian payment methods
payer.ci	string	Optional	Customer identity document (Cédula de Identidad) for Bolivia/Venezuela payment methods. For Venezuela it must start with letter possible values: V, E
payer.ruc	string	Optional	Ecuadorian taxpayer number (Registro Único de Contribuyente)
payer_account	object	Optional	Customer account data section
payer_account.bank_code	string	Optional	Payer bank code (Mandatoriness see in section Supported payment methods). One of bank code from list (see Bank Codes section)
payment_options.return_url	string	Optional	If passed, the customer will be returned to the specified URL after the payment is completed
payment_options.callback_url	string	Optional	If passed, the notification on payment status change will be sent to the specified URL