Skip to content

Get a project contract

GET
/v1/admin/merchants/{merchant_id}/projects/{project_id}/contracts/{contract}/

Returns the fields of the contract.

Authorization

apiKey
headerAuthorizationBasic <token>

HTTP Basic authentication with an admin API key as the username and an empty password.

Path Parameters

merchant_id*string

The ID of the merchant.

Formatuuid
project_id*string

The ID of the project.

Formatuuid
contract*string

The contract type: silverflow-v2, silverflow-oct, ginger-elavon, rapyd, shift4, credit-card, amex, google-pay, apple-pay, bancontact, vipps-mobilepay or swish. See Processor contracts.

Response Body

The fields of the contract.

application/json
  1. response

Visa, Mastercard and Bancontact through Silverflow. With boarding_mode disabled, give the acceptor_key per scheme. With acceptors-only (needs merchant_key) or full-merchant, give the bin_key and mid per scheme, and Ginger boards the merchant at Silverflow. See Silverflow merchant boarding.

begin_date?string

Start date of the contract (ISO 8601).

end_date?|

End date of the contract (ISO 8601).

funding_delay?integer

Days to wait with funding after a sale or capture.

manual_capture_enabled?boolean

Allow manual capture. See Capture modes.

delayed_capture_enabled?boolean

Allow delayed capture.

boarding_mode*string
Value in"disabled""acceptors-only""full-merchant"
boarding_status?string

The result of automatic boarding, or the field to fix.

merchant_key?string

The Silverflow merchant key. Required for acceptors-only.

currencies?array<string>

ISO 4217 currency codes the contract accepts.

dynamic_3ds_rules?array<>

Dynamic 3DS rules, evaluated top to bottom. The first enabled rule whose conditions all match decides. See Dynamic 3-D Secure rules.

schemes*
curl -X GET 'https://api.example.com/v1/admin/merchants/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/contracts/string/' \  --user "$API_KEY:"
{  "boarding_mode": "disabled",  "boarding_status": "string",  "merchant_key": "string",  "currencies": [    "EUR",    "USD"  ],  "dynamic_3ds_rules": [    {      "name": "string",      "conditions": [        {          "field": "card_issuing_country",          "operator": "in",          "value": [            "st"          ]        }      ],      "action": {        "request_3ds": "always"      },      "enabled": true    }  ],  "schemes": {    "visa": {      "charge_type": "charge",      "acceptor_key": "string",      "bin_key": "string",      "mid": "string",      "boarding_status": "string",      "scheme_transaction_type": "string",      "funding_type": "string",      "sender_is_receiver": false,      "receiver_first_name": "string",      "receiver_last_name": "string",      "receiver_account_number": "string",      "receiver_account_number_type": "card-account",      "purpose_of_payment": "string"    },    "mastercard": {      "charge_type": "charge",      "acceptor_key": "string",      "bin_key": "string",      "mid": "string",      "boarding_status": "string",      "scheme_transaction_type": "string",      "funding_type": "string",      "sender_is_receiver": false,      "receiver_first_name": "string",      "receiver_last_name": "string",      "receiver_account_number": "string",      "receiver_account_number_type": "card-account",      "purpose_of_payment": "string"    },    "bancontact": {      "charge_type": "charge",      "acceptor_key": "string",      "bin_key": "string",      "mid": "string",      "boarding_status": "string",      "scheme_transaction_type": "string",      "funding_type": "string",      "sender_is_receiver": false,      "receiver_first_name": "string",      "receiver_last_name": "string",      "receiver_account_number": "string",      "receiver_account_number_type": "card-account",      "purpose_of_payment": "string"    }  },  "begin_date": "2026-11-01",  "end_date": "string",  "funding_delay": 0,  "manual_capture_enabled": true,  "delayed_capture_enabled": true}