Merchant Payment Method Configuration

Payment Method Configuration

Once a merchant has been onboarded, the next step is to configure their payment methods. This process involves two distinct API calls: one to discover available payment methods and their required credential structure, and a second to activate the chosen method.

Step 1: Discover Available Payment Methods

To begin, you must call the /merchant/provider/new endpoint. This API call returns a list of all available payment methods that can be configured for the merchant. Crucially, the response from this endpoint also provides the specific structure of the credentials required (credentialsFields) for each payment method. This information is essential for the next step. It can also be used to display and collect the relevant fields from your merchant.

• credentialsFields

  • name: The name of the field that should be passed in the credentials fields when enabling that payment method

  • infoGuide: A guide decribing the credential and where to get it in the payment providers portal

Step 2: Activate a Payment Method

After identifying the desired payment method, you will use the /merchant/provider/activate/new endpoint to activate it. In this call, you must pass the merchant's unique ID and the credentials for the chosen payment method. The credentials must be formatted exactly as outlined in the response from the previous /merchant/provider/new API call. Upon a successful call, the payment method will be enabled and ready for use by the merchant.

For basic testing purpose it is recommened to not specify a channel, if you wish to explore this functionality please look into the channels section on the merchant documentation.

The credentials used for enabling this method should be obtained directly from the merchants (or MoR) relationship with the payment method.

For testing purposes you can use the credentials below to enable a payment method and test putting through an order.

Credentials

Klarna AUD

Api Key 8e65ed69-d84e-4ddd-82a9-031de6181869

Api Secret klarna_test_api_dUZoaVVIYkticTB2LWhhd0QyMUhBbDIzU2ExIVg5d1EsOGU2NWVkNjktZDg0ZS00ZGRkLTgyYTktMDMxZGU2MTgxODY5LDEsQitidkE1SnJzckZuUXZIUDZJM1pXQTFKTmZZSzJnTGVBMW1rbTY4aUcyaz0

Go Cardless USD

Access Token: sandbox_rtjNuRcBr12GVuepqzBmOo9uyiYBpcuRMZFG8ezy

Webhook Secret: vhx87n-P8VLdflbih838YOKJHYzc7bwmZ7s0i_xy

Volt AUD

username: [e-mail]

Public Key Id: 5f0cbe19-a757-4f33-8178-0177386d51ae

Password: $4EOtj%2s6@#fMzlu9YR*10H&3v7Z!G1

Private key:

-----BEGIN PRIVATE KEY----- MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQClkADrP+95yyyhFSdIH7dwf3u3I+IoumCNZHkh1pAHvC2zG0jiopy7jzCLfIO+gxq/Kn31eiKNU8itNXNIE2VgjMeTzEqZ3k6aTkND2F4R6SEbYNy/JVwaKZLnYqMJGbDsSu7PgOBfBpwAyOWR8XKnsi3IszEyo2WxCIR6maIzel/8gIXig/WNDYV1ojcZxKyszk4BA9PiuFF4eQEaGWebGKdU/DKQruCpQws4K8OU4Iynj+Ff+JQG+F3MPjcqM6IaxsK7Ec6DDBFvOJ9H1g4diWgukDdvMPBSavfFTwBxEIVT8s3wGYbAk6o7acXEhqsOgoGT/HVnV/PGS4CUpa1bAgMBAAECggEAOWVy7Bt+KfsFvdJXi+ly7s1DVnpaLURvtJTgaZq40/Wo4i7TVb6KF3vMmI7SHXnWC+/vOurcj6I8L9AX5yTSQGaNye9I7Y7kMRpwt1SLSCpKD/PEk3+gLnG7O/w2CTGe5EwV/lnvbwIbkyoSbEYIOZrLxIhaxfNfjcAmLVqVoMJ81NKLiIiamUYGgpQfJ7qf7AGDT/tCzr8vNNIbINdWzJuXgP+ErrV0FcoCZvGcm3tGn9MpGnxAOFdsjHdrpCWpgyTzqk10BbFUYJFNjFN/Iy/5GSB4u/9e6W8tUpoRtcQFBM+nBrxvyE/oxylYdSX2m447IXLVVTCaawU6DS6YAQKBgQDetE/JhcpbhIK0XG3hT02sFVuKB0J4mxCsa1wKKOH5Io3s3Vv6ENDxHrj4ADY7bTLxisU6wPo/rcrpQm6fy/Tbxc8UMCJ6dGnfGJngfOxg8kHmeJC/P480W7RE9FwznhyI40YlGs5G23HWdULcuFyhfDU5hyLPx2UBTcIs7eTo0QKBgQC+UKuvE6oP6pvEBW8WYOPOZgjyptd/8dF+PtspkXWK6TDm2uHHe5szM03y7/tCx3/KZsbx0zb/Ykkp250zisKWRxpmQhamDMU89B9OryM8xzumYse90IgxDDBQAHWi0fyyySPfYvTSOvMfO33PduikmLzM6+Gu6LdHQKcyRan+awKBgFS8dr9O0LgRq0nFAWoBKqSXW8UhDgGlvqpcDyEufQy2QRom/6AeVeHotqhmLDxgSEnvayv30T/5eINYa48Ro5EbqrcbuYKuWLoyOhpYbfhVNQ3kQe8C2BIr8mNqNsrNFj5fe4kSsfnz9VSMOWySGWy4Pegtquk0DRJ566/8tGSBAoGAYVKLmUprCxykb0eAGWeO13uiU8QyK8GTqgWmucki3NiHI2cHUqXJJhO0ZumGCg5PMUgBsKScWVj/pSIjb7oj7AmMXIKrZlrdemA0ql4xnOEdhea50j2Th9F920uA3LSZjywA5jmKjP+MWIppufBK4/Efi4OMs49aOlu7pJ+vYOUCgYAF6bagHBKWL/S4tm7PluXlT8DS3vwadTXlH9ieCEw23gnXHethSmThyZ9qOPn0dDsQ5wDyZHvAo+WzMn/hJ0WdXVUgLDF2Y7JbIQ+QmZDHp3exQELRjQnTd27OtZ2dtUxSMhMvSjw80xCCzvxoNiXxlOsVY0uzQszBBjCA313efA== -----END PRIVATE KEY-----

FatZebra 3DS

username: vsmrt-TESToptty

sharedSecret: 733d8b567c

access_key: 1DrrvOD8CW5FIA== token: 5517fa6e8f1580b6904b735106baa7be60b38eb6

access_secret: g4amFj1RTJwQrJpUHUN_xGUmYZw=

Test Data

Klarna AUD

Phone Number: [phone]

Go Cardless USD

All Defaults

Routing Number: 026073150

Account Number: 2715500356

Volt AUD

Any BSB and Account Number.

Or any PayId

FatZebra 3DS

Card Number: 4000000000001000 Card Holder Name: Any Expiry: Any Future Date CVC: Any 3 Digits