PaymentRedirectManagement

Singleton APS resource with methods for operations with payment redirect callback.

Schema

The considered APS type (download) extends the Resource APS type(s) and looks as follows:

{
  "name": "PaymentRedirectManagement",
  "id": "http://www.odin.com/billing/payment-redirect-management/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "access": {
    "public": true
  },
  "operations": {
    "redirectCallback": {
      "path": "/redirect/{docId}/callback",
      "verb": "GET",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "docId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "redirectPostCallback": {
      "path": "/redirect/{docId}/callback",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "docId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "redirectCallbackWithStatus": {
      "path": "/redirect/{docId}/{result}/callback",
      "verb": "GET",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "docId": {
          "kind": "path",
          "type": "string"
        },
        "result": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "redirectPostCallbackWithStatus": {
      "path": "/redirect/{docId}/{result}/callback",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "docId": {
          "kind": "path",
          "type": "string"
        },
        "result": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "redirectNotify": {
      "path": "/redirect/{docId}/notify",
      "verb": "GET",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "docId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "redirectPostNotify": {
      "path": "/redirect/{docId}/notify",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "docId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "secure3DCallback": {
      "path": "/redirect/{docId}/3dsecure",
      "verb": "GET",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "docId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "secure3DPostCallback": {
      "path": "/redirect/{docId}/3dsecure",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "docId": {
          "kind": "path",
          "type": "string"
        }
      }
    }
  }
}

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
redirectCallback	GET	/redirect/{docId}/callback	Response	Callback from payment redirect response.
redirectCallbackWithStatus	GET	/redirect/{docId}/{result}/callback	Response	Callback from payment redirect response.
redirectNotify	GET	/redirect/{docId}/notify	Response	Callback for payment notify.
redirectPostCallback	POST	/redirect/{docId}/callback	Response	Callback from payment redirect response. Consumes ‘application/x-www-form-urlencoded’
redirectPostCallbackWithStatus	POST	/redirect/{docId}/{result}/callback	Response	Callback from payment redirect response. Consumes ‘application/x-www-form-urlencoded’
redirectPostNotify	POST	/redirect/{docId}/notify	Response	Callback for payment notify. Consumes ‘application/x-www-form-urlencoded’
secure3DCallback	GET	/redirect/{docId}/3dsecure	Response	Callback for 3dsecure payment redirect.
secure3DPostCallback	POST	/redirect/{docId}/3dsecure	Response	Callback for 3dsecure payment redirect. Consumes ‘application/x-www-form-urlencoded’

redirectCallback

HTTP Request

GET /aps/2/resources/{aps-id}/redirect/{docId}/callback

Description

Callback from payment redirect response.

Parameters

PARAMETER	TYPE	DESCRIPTION
docId	String	Payment document identifier

Returns

Response

redirectCallbackWithStatus

HTTP Request

GET /aps/2/resources/{aps-id}/redirect/{docId}/{result}/callback

Description

Callback from payment redirect response.

Parameters

PARAMETER	TYPE	DESCRIPTION
docId	String	Payment document identifier
result	String	State of payment request {@code ok} or {@code fail}

Returns

Response

redirectNotify

HTTP Request

GET /aps/2/resources/{aps-id}/redirect/{docId}/notify

Description

Callback for payment notify.

Parameters

PARAMETER	TYPE	DESCRIPTION
docId	String	Payment document identifier

Returns

Response

redirectPostCallback

HTTP Request

POST /aps/2/resources/{aps-id}/redirect/{docId}/callback

Description

Callback from payment redirect response. Consumes ‘application/x-www-form-urlencoded’

Parameters

PARAMETER	TYPE	DESCRIPTION
docId	String	Payment document identifier
postParams		Callback parameters

Returns

Response

redirectPostCallbackWithStatus

HTTP Request

POST /aps/2/resources/{aps-id}/redirect/{docId}/{result}/callback

Description

Callback from payment redirect response. Consumes ‘application/x-www-form-urlencoded’

Parameters

PARAMETER	TYPE	DESCRIPTION
docId	String	Payment document identifier
postParams		Callback parameters
result	String	State of payment request {@code ok} or {@code fail}

Returns

Response

redirectPostNotify

HTTP Request

POST /aps/2/resources/{aps-id}/redirect/{docId}/notify

Description

Callback for payment notify. Consumes ‘application/x-www-form-urlencoded’

Parameters

PARAMETER	TYPE	DESCRIPTION
docId	String	Payment document identifier
postParams		Callback parameters

Returns

Response

secure3DCallback

HTTP Request

GET /aps/2/resources/{aps-id}/redirect/{docId}/3dsecure

Description

Callback for 3dsecure payment redirect.

Parameters

PARAMETER	TYPE	DESCRIPTION
docId	String	Payment document identifier

Returns

Response

secure3DPostCallback

HTTP Request

POST /aps/2/resources/{aps-id}/redirect/{docId}/3dsecure

Description

Callback for 3dsecure payment redirect. Consumes ‘application/x-www-form-urlencoded’

Parameters

PARAMETER	TYPE	DESCRIPTION
docId	String	Payment document identifier
postParams		Callback parameters

Returns

Response

Examples

Since the considered APS type contains custom operations, refer to Custom Operations for the general explanation of their structure and examples of operation calls.

← PaymentMethodManagement

Rated Data Export →