Payment Service Reference¶

GET https://payment.authentise.com/invoice/¶

Get information about a collection of invoices.

Request JSON Object:

charges (obj) – Required. The charges that are involved in this invoice. cost (obj) – Required. The sum of the charges and the type of currency. created (datetime) – Required. The time at which the invoice was created. due (datetime) – Required. The date that the amount must be paid by. payment_uuid (string) – Optional. This shows that the invoice was paid. status (string) – Required. The status of the payment paid, unpaid or overdue. taxes (list) – Required. Not Implemented. user_uri (string) – Required. The user that this invoice is tied to.

Example response

GET https://payment.authentise.com/invoice/
Content-Type: application/json
    {
          'charges'      : [{
            'action'       : '3dpdf',
            'amount'       : 0.50,
            'currency'     : 'USD',
            'invoice_uuid' : '3ce339ca-87ec-4da8-878f-0850dc6f68fc',
            'namespace'    : 'gojira',
            'source'       : 'https://integrations.authentise.com/operation/ac1a416b-13bc-481d-a408-46e676b990fa/',
            'type'         : 'per-use',
            'uuid'         : '7f2d2cee-7b20-4e06-9930-229387c8061e'}],
          'cost'         : {
            'amount'       : 0.50,
            'currency'     : 'USD'
          },
          'created'      : '2016-03-30T23:12:05.591525',
          'due'          : '2016-04-15T00:00:00',
          'payment_uuid' : '01369233-2e79-4ebf-9511-e81fd84edb41',
          'status'       : 'paid',
          'taxes'        : [],
          'uri'          : 'https://payment.authentise.com/invoice/95a56951-a5f2-43b7-bd1c-c65e216ba4d6/',
          'user_uri'     : 'https://users.authentise.com/users/b965f6dc-b4c3-4c29-9165-e6502750a2a1/',
    }

GET https://payment.authentise.com/invoice/<uuid>/¶

Get information about a specific invoice.

Request JSON Object:

charges (obj) – Required. The charges that are involved in this invoice. cost (obj) – Required. The sum of the charges and the type of currency. created (datetime) – Required. The time at which the invoice was created. due (datetime) – Required. The date that the amount must be paid by. payment_uuid (string) – Optional. This shows that the invoice was paid. status (string) – Required. The status of the payment paid, unpaid or overdue. taxes (list) – Required. Not Implemented. user_uri (string) – Required. The user that this invoice is tied to.

Bad requests

404 PaymentStatusNotFound If payment-status does not exist

Example response

GET https://payment.authentise.com/invoice/95a56951-a5f2-43b7-bd1c-c65e216ba4d6/
Content-Type: application/json
    {
          'charges'      : [{
            'action'       : '3dpdf',
            'amount'       : 0.50,
            'currency'     : 'USD',
            'invoice_uuid' : '3ce339ca-87ec-4da8-878f-0850dc6f68fc',
            'namespace'    : 'gojira',
            'source'       : 'https://integrations.authentise.com/operation/ac1a416b-13bc-481d-a408-46e676b990fa/',
            'type'         : 'per-use',
            'uuid'         : '7f2d2cee-7b20-4e06-9930-229387c8061e'}],
          'cost'         : {
            'amount'       : 0.50,
            'currency'     : 'USD'
          },
          'created'      : '2016-03-30T23:12:05.591525',
          'due'          : '2016-04-15T00:00:00',
          'payment_uuid' : '01369233-2e79-4ebf-9511-e81fd84edb41',
          'status'       : 'paid',
          'taxes'        : [],
          'uri'          : 'https://payment.authentise.com/invoice/95a56951-a5f2-43b7-bd1c-c65e216ba4d6/',
          'user_uri'     : 'https://users.authentise.com/users/b965f6dc-b4c3-4c29-9165-e6502750a2a1/',
    }

GET https://payment.authentise.com/payment-status/¶

Get a collection of payment’s statuses.

Request JSON Object:

namespace (string) – Required. The name of the project that initiated the charge. action (string) – Required. The type of operation. consented (boolean) – Required. If the user has consented to the payment or not. cost (obj) – Required. The sum of the charges and the type of currency for this payment. details (string) – Required. A sentence explaining the status and how to fix it. status (string) – Required. The status of the payment, ok, consent-required, method-of-payment-required. type (string) – Required. The payment option like per-use.

Example request full

GET https://payment.authentise.com/payment-status/
Content-Type: application/json

{
      'action'    : '3dpdf',
      'consented' : True,
      'cost'      : {
        'amount'    : 0.50,
        'currency'  : 'USD'
      },
      'details'   : 'Payment data ready and Consent given',
      'namespace' : 'gojira',
      'status'    : 'ok',
      'type'      : 'per-use',
      'uri'       : 'https://payment.authentise.com/payment-status/3d6a18e2-0ffd-4f14-bb41-e40330c09ba7/'
}

Example details and status

If you have not consented to the payment

'details' : 'This action requires consent. Please send a POST to https://payment.authentise.com/consent/'
'status'  : 'consent-required',

If you have no payment setup

'details' : 'This action will result in a charge on your account. In order to take this action you must setup a valid method of payment',
'status'  : 'consent-required',

If you have payment setup and have consented to this action

'details' : 'Payment data ready and Consent given',
'status'  : 'ok',

GET https://payment.authentise.com/payment-status/<uuid>/¶

Get information about a specific payment’s status.

Request JSON Object:

namespace (string) – Required. The name of the project that initiated the charge. action (string) – Required. The type of operation. consented (boolean) – Required. If the user has consented to the payment or not. cost (obj) – Required. The sum of the charges and the type of currency for this payment. details (string) – Required. A sentence explaining the status and how to fix it. status (string) – Required. The status of the payment, ok, consent-required, method-of-payment-required. type (string) – Required. The payment option like per-use.

Example request

GET https://payment.authentise.com/payment-status/3d6a18e2-0ffd-4f14-bb41-e40330c09ba7/
Content-Type: application/json

{
      'action'    : '3dpdf',
      'consented' : True,
      'cost'      : {
        'amount'    : 0.50,
        'currency'  : 'USD'
      },
      'details'   : 'Payment data ready and Consent given',
      'namespace' : 'gojira',
      'status'    : 'ok',
      'type'      : 'per-use',
      'uri'       : 'https://payment.authentise.com/payment-status/3d6a18e2-0ffd-4f14-bb41-e40330c09ba7/'
}

GET https://payment.authentise.com/consent/¶

Get information about a collection of consents.

Request JSON Object:
	namespace (string) – Required. The name of the project that initiated the charge. action (string) – Required. The type of operation. consented (boolean) – Required. If the user has consented to the payment or not. user_uri (string) – Required. The user that consented. uuid (string) – Required. The uuid tag for the consent.

Example request

GET https://payment.authentise.com/consent/
Content-Type: application/json

{
      'action'    : '3dpdf',
      'consented' : True,
      'namespace' : 'gojira',
      'user_uri'  : 'https://users.authentise.com/users/b965f6dc-b4c3-4c29-9165-e6502750a2a1/',
      'uuid'      : '3d6a18e2-0ffd-4f14-bb41-e40330c09ba7'
}

GET https://payment.authentise.com/consent/<uuid>/¶

Get information about a specific consent.

Request JSON Object:
	namespace (string) – Required. The name of the project that initiated the charge. action (string) – Required. The type of operation. consented (boolean) – Required. If the user has consented to the payment or not. user_uri (string) – Required. The user that consented. uuid (string) – Required. The uuid tag for the consent.

Example request

GET https://payment.authentise.com/consent/3d6a18e2-0ffd-4f14-bb41-e40330c09ba7/
Content-Type: application/json

{
      'action'    : '3dpdf',
      'consented' : True,
      'namespace' : 'gojira',
      'user_uri'  : 'https://users.authentise.com/users/b965f6dc-b4c3-4c29-9165-e6502750a2a1/',
      'uuid'      : '3d6a18e2-0ffd-4f14-bb41-e40330c09ba7'
}

POST https://payment.authentise.com/consent/¶

Create a Consent.

Request JSON Object:
	namespace (string) – Required. The name of the project that initiated the charge. action (string) – Required. The type of operation. consented (boolean) – Required. If the user has consented to the payment or not. user_uri (string) – Required. The user that consented.

Example request

POST https://payment.authentise.com/consent/
Content-Type: application/json

{
      'action'    : '3dpdf',
      'consented' : True,
      'namespace' : 'gojira',
      'user_uri'  : 'https://users.authentise.com/users/b965f6dc-b4c3-4c29-9165-e6502750a2a1/',
}