Loading...
To run a loan sale, program the POS to send a POST request to the relevant endpoint.
| Scenario | Merchant uses the POS to: |
|---|---|
| The loan provider approves a customer's application for a loan. | Take payment for the item. |
Send the temporary token from Payfields in the temporary_token parameter.
| Environment | HTTP Method | URL |
|---|---|---|
| Test | POST | https://api.pit.paygateway.com/transactions/loansales |
| Production | POST | https://api.paygateway.com/transactions/loansales |
| Object | Parameter | Type | Size | Required? | Description |
|---|---|---|---|---|---|
| N/A | reference_id | String | 1-50 | Required | Unique identifier for the loan sale. This is an alphanumeric value that the merchant creates, for example, XAZR863990. |
| loan | temporary_token | String | 1-36 | Required | Temporary identifier for the loan, for example, fa8859e6-eec1-4289-a20b-de5ffc84c9da. Our gateway creates this temporary token when the customer’s loan application is successful. The gateway then returns the token to the payment page. Note: You can use this token only once. |
| payment | invoice_number | String | 1-25 | Required | Alphanumeric invoice number or order number that the merchant creates and assigns to the loan sale. |
| transaction | country_code | String | Explicit | Required | Code that represents the country where the loan sale originated. For a list of possible values, see the country code enumeration. |
| language | String | Explicit | Required | Language for the text that displays on your payment page and the merchant's receipts. For a list of possible values, see the language enumeration. |
| Object | Field | Type | Description |
|---|---|---|---|
| N/A | loansale_id | String | Unique identifier that our gateway generated for the loan sale. Note: This is the loansale_id that you can include in the endpoint URL for follow-on transactions. |
| N/A | reference_id | String | Unique identifier that the merchant created for the loan sale. Note: This is the reference_id that you can include in the endpoint URL for follow-on transactions. |
| N/A | status | String | Indicates the status of the loan sale. The value is one of the following:• approved• declined• voided |
| N/A | processor_response | String | Response from the processor that describes the status of the loan sale. |
| payment | amount | String | Total loan amount. |
| currency_code | String | ISO currency code for the loan sale. For a list of possible values, see the currency code enumeration | |
| invoice_number | String | Alphanumeric invoice number or order number that the merchant created and assigned to the loan sale. | |
| type | String | Type of payment for the loan sale. The value is loan. | |
| transaction | country_code | String | Code that represents the country where the loan sale originated. For a list of possible values, see the country code enumeration |
| language | String | Language for the text that is displayed on your payment page and the merchant's receipts. For a list of possible values, see the language enumeration. | |
| links | loansale_id | Object | Object that includes HATEOAS links for follow-on transactions using the loansale_id. For a list of fields, see the object. |
loansale_id object
| Field | Type | Description |
|---|---|---|
| href | String | Endpoint URL for follow-on transactions using the loansale_id. |
| relation | String | Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following:• return - The transaction uses the returns endpoint.• self - The transaction uses the same type of endpoint as the original request.• void - The transaction uses the void endpoint. |
| method | String | HTTP method for sending the request. The value is one of the following:• GET• PATCH• POST• PUT |
| description | String | Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous loan sale transaction using a loansale_id. |
reference_id object
| Field | Type | Description |
|---|---|---|
| href | String | Endpoint URL for follow-on transactions using the reference_id. |
| relation | String | Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following:• return - The transaction uses the returns endpoint.• self - The transaction uses the same type of endpoint as the original request.• void - The transaction uses the void endpoint. |
| method | String | HTTP method for sending the request. The value is one of the following:• GET• PATCH• POST• PUT |
| description | String | Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous loan sale transaction using a reference_id. |
| reference_id | Object | Object that includes HATEOAS links for follow-on transactions using the reference_id. For a list of fields, see the reference_id object. |